Skip to content

Typed variadic arguments fail to be injected #30888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: 2.4-develop
Choose a base branch
from
Open

Typed variadic arguments fail to be injected #30888

wants to merge 4 commits into from

Conversation

adrian-martinez-interactiv4
Copy link
Contributor

@adrian-martinez-interactiv4 adrian-martinez-interactiv4 commented Nov 12, 2020 •
edited
Loading

Description (*)

Related with #24556.

That PR allowed to inject scalar values as variadic parameters, but does not work for object injections. Object definitions don't get instantiated, and target class constructor receives an array of strings instead (with '_instance' key, that should have been transformed into real objects).

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
  <!-- Declare di arguments injection -->
    <type name="Interactiv4\EmailAttachments\Mail\AttachmentsProcessor">
        <arguments>
            <!-- This argument is a typed variadic one -->
            <argument name="attachmentProviders" xsi:type="array">
                <!-- This argument value is an object implementing variadic argument type -->
                <item name="invoice" xsi:type="object">Interactiv4\SalesEmailAttachments\Mail\AttachmentProvider\InvoiceAttachmentProvider</item>
            </argument>
        </arguments>
    </type>
</config>

With proposed changes, variadic arguments are interpreted when needed to be transformed into real objects. Scalar/other variadic arguments will continue working as previously.

Second commit also fixes objects are not being injected into target class constructor when all this conditions are satisfied:

  • Target class constructor has a single, variadic, constructor argument.
  • A factory is used to inject variadic arguments dynamically.
  • Running in compiled mode.

Related Pull Requests

#24556

Fixed Issues (if relevant)

  1. resolves [Issue] Typed variadic arguments fail to be injected #30931: Typed variadic arguments fail to be injected

Manual testing scenarios (*)

  1. Create a class with a typed variadic argument in it:
class Test
{
    public function __construct(SomeInterface ...$interfaceInstances){}
}
  1. Inject via di.xml instances of given interface, similar as shown in summary.
  2. Prior to this proposed change it fails complaining of type error on object construct.

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Nov 12, 2020

Hi @adrian-martinez-interactiv4. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@magento-engcom-team magento-engcom-team added Component: ObjectManager Release Line: 2.4 Partner: Interactiv4 Pull Request is created by partner Interactiv4 partners-contribution Pull Request is created by Magento Partner labels Nov 12, 2020
@adrian-martinez-interactiv4
Copy link
Contributor Author

@magento run all tests

@adrian-martinez-interactiv4 adrian-martinez-interactiv4 changed the title Allow use factories and OM for creating objects with variadic arguments in constructor Typed variadic arguments fail to be injected Nov 12, 2020
@sidolov sidolov added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Nov 16, 2020
@sidolov
Copy link
Contributor

sidolov commented Nov 16, 2020

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Nov 16, 2020
Closed
4 tasks
@adrian-martinez-interactiv4
Copy link
Contributor Author

@magento run all tests

@adrian-martinez-interactiv4
Allow use factories and OM for creating objects with variadic argumen…
82fd193 
…ts in constructor

Related with magento#24556.

That PR allowed to inject scalar values as variadic parameters, but do not work for objects injections. Object definitions don't get instantiated, and target class constructor receives an array of strings instead (with '_instance' key, that should have been transformed into real object)
@adrian-martinez-interactiv4
Allow objects to be properly injected through factories when variadic…
f3cfb91 
… argument is the only one in constructor, and compiled mode is used
@adrian-martinez-interactiv4
Copy link
Contributor Author

@magento run all tests

@adrian-martinez-interactiv4
Copy link
Contributor Author

@magento run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Component: ObjectManager Partner: Interactiv4 Pull Request is created by partner Interactiv4 partners-contribution Pull Request is created by Magento Partner Priority: P3 May be fixed according to the position in the backlog. Progress: pending review Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Typed variadic arguments fail to be injected
3 participants
@adrian-martinez-interactiv4 @sidolov @magento-engcom-team